/*
 * Copyright 2012 Finbudget.com
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package finbudget.client.lists;

import com.google.gwt.event.shared.EventHandler;
import com.google.gwt.event.shared.GwtEvent;
import finbudget.client.lists.GetListOfItems.BudgetListItem;
import finbudget.client.lists.GetListOfItems.ListType;

/**
 *
 */
public class NewItemAddedToListEvent extends GwtEvent<NewItemAddedToListEvent.NewItemAddedToListHandler> {
	public interface NewItemAddedToListHandler extends EventHandler {
		/**
		 * This method should react on adding new item to a list.
		 * List type and the name of the new item are in the event.
		 * @param event details of the event.
		 */
		void onNewItemAdded(NewItemAddedToListEvent event);
	}

	public static final Type<NewItemAddedToListHandler> TYPE = new Type<NewItemAddedToListHandler>();
	
	private final ListType listType;
	private final BudgetListItem item;
	
	public NewItemAddedToListEvent(ListType listType, BudgetListItem item) {
		this.listType = listType;
		this.item = item;
	}

	public NewItemAddedToListEvent(NewItemAddedToListEventDto dto) {
		this.listType = dto == null ? null : dto.getListType();
		this.item = dto == null ? null : dto.getItem();
	}
	
	@Override
	public com.google.gwt.event.shared.GwtEvent.Type<NewItemAddedToListHandler> getAssociatedType() {
		return TYPE;
	}

	@Override
	protected void dispatch(NewItemAddedToListHandler handler) {
		handler.onNewItemAdded(this);
	}

	/**
	 * @return the listType
	 */
	public ListType getListType() {
		return listType;
	}

	/**
	 * @return the item
	 */
	public BudgetListItem getItem() {
		return item;
	}

}
